Skip to content

Add documentation for publishing to npm with Trusted Publisher (OIDC)#1536

Merged
HarithaVattikuti merged 3 commits intoactions:mainfrom
chiranjib-swain:docs/oidc-publishing
Apr 23, 2026
Merged

Add documentation for publishing to npm with Trusted Publisher (OIDC)#1536
HarithaVattikuti merged 3 commits intoactions:mainfrom
chiranjib-swain:docs/oidc-publishing

Conversation

@chiranjib-swain
Copy link
Copy Markdown
Contributor

@chiranjib-swain chiranjib-swain commented Apr 22, 2026

Description:
This pull request updates the documentation to add guidance on publishing npm packages using Trusted Publisher (OIDC), which allows secure publishing from GitHub Actions without long-lived npm tokens. The changes clarify requirements, provide an example workflow, and link to relevant resources.

Documentation updates for npm Trusted Publisher (OIDC):

  • Added a new section in docs/advanced-usage.md explaining how to publish to npm using Trusted Publisher (OIDC), including requirements, an example workflow, and important notes for configuration.
  • Updated the README.md to include a link to the new Trusted Publisher (OIDC) documentation section.

Related issue:
#1445

Check list:

  • Mark if documentation changes are required.
  • Mark if tests were added or updated to cover the changes.

Copilot AI review requested due to automatic review settings April 22, 2026 11:18
@chiranjib-swain chiranjib-swain requested a review from a team as a code owner April 22, 2026 11:18
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds documentation for publishing npm packages from GitHub Actions using npm Trusted Publishers (OIDC), and links to that guidance from the README.

Changes:

  • Added a new “Publishing to npm with Trusted Publisher (OIDC)” section to docs/advanced-usage.md (requirements, example workflow, and configuration notes).
  • Added a README link to the new documentation section.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
docs/advanced-usage.md Introduces a new section describing npm Trusted Publisher (OIDC) publishing flow and an example workflow snippet.
README.md Adds a table-of-contents link to the new advanced usage section.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/advanced-usage.md Outdated
Comment thread docs/advanced-usage.md
Comment thread docs/advanced-usage.md Outdated
@HarithaVattikuti HarithaVattikuti merged commit 670825a into actions:main Apr 23, 2026
3 checks passed
@chiranjib-swain chiranjib-swain deleted the docs/oidc-publishing branch April 23, 2026 03:02
@chiranjib-swain chiranjib-swain self-assigned this Apr 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants